<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xml:lang="en" xmlns="http://www.w3.org/1999/xhtml">
<head>
  <title>Trull: Installation and Usage Instructions</title>
  <link type="text/css" href="trull.css" rel="StyleSheet" />
</head>
<body>
<h1>Trull: Installation and Usage Instructions</h1>
<h2>System Requirements</h2>
<p>Trull requires 
 <a href="http://java.sun.com/j2se/">Java 2
Standard Edition (J2SE)</a>, preferably J2SE 1.3 or newer.</p>
<p>Trull also requires
<a href="http://ant.apache.org/">Apache Ant</a> 1.6.0 or newer for
building from source or running the demos locally (optional).</p>
<p>Trull also requires the following libraries and frameworks, which
are already included in binary form in this distribution:</p>
<ul>
  <li><a href="http://gee.cs.oswego.edu/dl/cpj/">util.concurrent</a></li>
  <li><a href="http://www.junit.org/">JUnit</a></li>
  <li><a href="http://jakarta.apache.org/log4j/">Log4j</a></li>
</ul>
<p>Optionally, Trull uses the following libraries and frameworks, which
are also included in binary form in this distribution:</p>
<ul>
  <li><a href="http://www.springframework.org/">Spring Framework</a>
    (spring-core.jar and spring-beans.jar only)
  </li>
  <li><a href="http://jakarta.apache.org/commons/">Jakarta Commons logging</a>
    (required by the Spring Framework)
  </li>
</ul>
<p>The Trull team is grateful to the developers of these high-quality
frameworks.</p>
<h2>Installation</h2>
<p>Unzip trull-VERSION.zip or trull-VERSION.tar.gz in a suitable
directory.  None of the directory names involved should contain
spaces.</p>
<h2>Usage</h2>
<p>If you do not have Apache Ant, you can run the demos using 
Java Web Start through the <a href="api/index.html">API documentation</a>.  
</p>
<p>If you do have Ant, you can run the demos from the top-level project directory like so:</p>
<pre>
    ant demo-battleship
    ant demo-counter1
    ant demo-counter1a
    ant demo-counter2
    ant demo-counter3
    ant demo-counter4
    ant demo-counter5
    ant demo-counter6
    ant demo-microwave
    ant demo-office
    ant demo-rmi1        # run each of demo-rmi1 and demo-rmi2 in a
    ant demo-rmi2        # different terminal on the same machine
    ant demo-stopwatch
    ant demo-wristwatch
    ant demo-tasktimer
    ant demo-tasksimple
    ant demo-taskcomplex
    ant demo-swingtester
</pre>
<p>For complete documentation of the Trull Java API and demos,
please refer to the <a href="api/index.html">API
documentation</a>.</p>
<p>Trull will soon include an XML-based front end. 
<!--
Please refer to <a href="ref/index.html">Trull XML reference</a>, the 
<a href="ref/examples/">Trull XML examples</a>, and the sources for
the counter, microwave, and office demos. The trull DOCTYPE is
defined in <a href="../trull.dtd">trull.dtd</a>.
-->
</p>
<h2>Building from Source (Optional)</h2>
<ul>
  <li>To build the project:
    <pre>    ant</pre>
  </li>
  <li>To regenerate the javadoc:
    <pre>    ant javadoc</pre>
  </li>
  <li>To create a full distribution:
    <pre>    ant dist</pre>
  </li>
  <li>To clean the build tree:
    <pre>    ant clean</pre>
  </li>
</ul>
<h2>Using Trull in your own Projects</h2>
<p>You should include the following libraries in the project:</p>
<ul>
<li>lib/trull.jar</li>
<li>lib/concurrent.jar</li>
<li>lib/log4j.jar</li>
</ul>
<h2>Using Trull with the Spring Framework</h2>
<p>In addition, you should include the following libraries:</p>
<ul>
<li>lib/spring-core.jar</li>
<li>lib/spring-beans.jar</li>
<li>lib/commons-logging.jar</li>
</ul>
<p>Please see the wristwatch demo for details.</p>
</body>
</html>
